Skip to content

[codex] docs: add pipeline extension recipe#1758

Open
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-pipeline-extension-docs
Open

[codex] docs: add pipeline extension recipe#1758
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-pipeline-extension-docs

Conversation

@ketpatil77

@ketpatil77 ketpatil77 commented Jul 3, 2026

Copy link
Copy Markdown

Description

Headroom already supports headroom.pipeline_extension, but request-normalization pattern was not documented. That leaves users guessing how to fix upstream quirks such as content: null tool-call payloads.

Closes #1758

Type of Change

  • Documentation update

Changes Made

  • Added a Pipeline Extensions section to configuration.mdx.
  • Documented the PRE_SEND hook as the right place for request cleanup.
  • Included a minimal NormalizeNullContent example and entry-point registration.
  • Mentioned x-headroom-base-url as the per-request routing override.

Testing

  • Unit tests pass (pytest)
  • Linting passes (ruff check .)
  • Type checking passes (mypy headroom)
  • New tests added for new functionality
  • Manual testing performed

Test Output

Docs-only verification:
- Reviewed docs diff for API names, hook names, and placement.
- Confirmed example uses public `headroom.pipeline` contract and matches existing header-routing terminology.

Real Behavior Proof

  • Environment: GitHub PR diff review for docs-only extension recipe.
  • Exact command / steps: Compared new configuration docs against public pipeline-extension and per-request routing interfaces already exposed by Headroom.
  • Observed result: Docs now show concrete request-cleanup extension pattern without requiring a fork.
  • Not tested: Live extension package execution in this verification pass.

Review Readiness

  • I have performed a self-review
  • This PR is ready for human review

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the CHANGELOG.md if applicable

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

PR governance

This PR follows the template and is marked ready for human review.

@github-actions github-actions Bot added status: needs author action Pull request body or readiness checklist still needs author updates and removed status: needs author action Pull request body or readiness checklist still needs author updates labels Jul 3, 2026
@ketpatil77

Copy link
Copy Markdown
Author

Docs diff is complete from my side and the PR body already follows the required template. This draft can be reviewed whenever maintainers want to take the docs batch.

@ketpatil77 ketpatil77 marked this pull request as ready for review July 4, 2026 15:00
@github-actions github-actions Bot added the status: ready for review Pull request body is complete and the author marked it ready for human review label Jul 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: ready for review Pull request body is complete and the author marked it ready for human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant